Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix error message disappear #35871

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Feb 6, 2024

Details

  • This PR will fix the issue: Scan - Merchant message disappears after deleting receipt and reappears after adding receipt

Fixed Issues

$ #34997
PROPOSAL: #34997 (comment)

Tests

  1. Go to workspace chat
  2. Create a scan request
  3. While the scanning is ongoing, navigate to the request details page and manually enter amount
  4. Click on the receipt and delete it
  5. Verify that the error and RBR stay at the 'Merchant' field
  6. Add a receipt
  7. Verify that the error and RBR stay at the 'Merchant' field
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go to workspace chat
  2. Create a scan request
  3. While the scanning is ongoing, navigate to the request details page and manually enter amount
  4. Click on the receipt and delete it
  5. Verify that the error and RBR stay at the 'Merchant' field
  6. Add a receipt
  7. Verify that the error and RBR stay at the 'Merchant' field
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Screencast.from.07-02-2024.18.05.28.webm
Android: mWeb Chrome
Screencast.from.06-02-2024.11.59.58.webm
iOS: Native
Screencast.from.06-02-2024.13.29.55.webm
iOS: mWeb Safari
Screencast.from.06-02-2024.11.57.55.webm
MacOS: Chrome / Safari
Screencast.from.06-02-2024.11.45.05.webm
MacOS: Desktop
Screencast.from.06-02-2024.13.24.32.webm

@dukenv0307 dukenv0307 requested a review from a team as a code owner February 6, 2024 05:00
@melvin-bot melvin-bot bot requested review from c3024 and removed request for a team February 6, 2024 05:00
Copy link

melvin-bot bot commented Feb 6, 2024

@c3024 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@c3024
Copy link
Contributor

c3024 commented Feb 6, 2024

Please merge main. Typechecks are fixed on it.

@dukenv0307
Copy link
Contributor Author

@c3024 I updated.

@c3024
Copy link
Contributor

c3024 commented Feb 8, 2024

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
receiptErrorAndroid.mp4
Android: mWeb Chrome
receiptErrorAndroidChrome.mp4
iOS: Native
receiptErroriOS.mp4
iOS: mWeb Safari
receiptErroriOSSafari.mp4
MacOS: Chrome / Safari
scanRequest.mp4
manualRequest.mp4
distanceRequest.mp4
manualRequestOneToOne.mp4
scanRequestOneToOne.mp4
MacOS: Desktop
receiptErrorDesktop.mp4

@c3024
Copy link
Contributor

c3024 commented Feb 8, 2024

I think RBR on LHN as well should be fixed within this issue.

fixError.mp4

@dukenv0307 @Julesssss

@Julesssss
Copy link
Contributor

I think RBR on LHN as well should be fixed within this issue.

Ah, so that occurs with this PR, but not on main? If so I agree.

@c3024
Copy link
Contributor

c3024 commented Feb 9, 2024

No this PR did not introduce it. The behaviour is already there are on main.

@c3024
Copy link
Contributor

c3024 commented Feb 13, 2024

No, this PR did not introduce it. The behaviour is already there are on main.

When there is an error shown at a mandatory field, I think it is logical to show RBR on LHN as well. That's why I asked if showing RBR on LHN should be included within the scope of this issue. This PR did not change any behaviour that already existed on main w.r.t. LHN.

@Julesssss

@Julesssss
Copy link
Contributor

When there is an error shown at a mandatory field, I think it is logical to show RBR on LHN as well. That's why I asked if showing RBR on LHN should be included within the scope of this issue

Okay got it.

@dukenv0307 could you please apply a change to your PR to ensure the error is shown on the LHN?

@dukenv0307
Copy link
Contributor Author

I am working on it

@dukenv0307
Copy link
Contributor Author

@c3024 I fixed comment #35871 (comment)

@c3024
Copy link
Contributor

c3024 commented Feb 15, 2024

I think once a request is deemed as a scan request, even if we remove the receipt, the error at the merchant field and RBRs on LHN should be same as when there was a receipt.

receiptError.mp4

Here, on member and admin side together there are total three red dots and zero green dots when there is a receipt. When the receipt is removed, IMO there should be the same dots as earlier. But there is one red dot and one green dot. @dukenv0307

cc: @Julesssss

@Christinadobrzyn
Copy link
Contributor

Hi there, can you check to see if this issue might be a regression from this PR?

@c3024
Copy link
Contributor

c3024 commented Feb 16, 2024

This PR hasn't been merged yet @Christinadobrzyn . That deploy blocker must be related to another issue.

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Feb 20, 2024

Daily update: Still working on the LHN RBR issues

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Feb 20, 2024

@c3024 The reason that leads to the behavior mentioned in this [comment] (#35871 (comment)) is that the condition here return false. So, to fix it, my plan is to remove all the hasReceipt functions that will be used in ReportUtils.hasSmartscanError . Below is the detail:

  1. First, update:

    App/src/libs/ReportUtils.ts

    Lines 2243 to 2246 in 0f372c2

    function hasMissingSmartscanFields(iouReportID: string): boolean {
    const transactionsWithReceipts = getTransactionsWithReceipts(iouReportID);
    return transactionsWithReceipts.some((transaction) => TransactionUtils.hasMissingSmartscanFields(transaction));
    }

    to:
function hasMissingSmartscanFields(iouReportID: string): boolean {
    return TransactionUtils.getAllReportTransactions(iouReportID).some((transaction) => TransactionUtils.hasMissingSmartscanFields(transaction));
}
  1. Then, update:
    function hasMissingSmartscanFields(transaction: OnyxEntry<Transaction>): boolean {
    return Boolean(transaction && hasReceipt(transaction) && !isDistanceRequest(transaction) && !isReceiptBeingScanned(transaction) && areRequiredFieldsEmpty(transaction));
    }

    to:
function hasMissingSmartscanFields(transaction: OnyxEntry<Transaction>): boolean {
    return Boolean(transaction && !isDistanceRequest(transaction) && !isReceiptBeingScanned(transaction) && areRequiredFieldsEmpty(transaction));
}
  • I tested and it works well. Do you have any feedback about this solution?

@c3024
Copy link
Contributor

c3024 commented Feb 22, 2024

Those changes work well. Please include them in the PR. @dukenv0307

@c3024
Copy link
Contributor

c3024 commented Feb 22, 2024

Please merge main as well because we need these changes included in this PR #36810 also to test correctly. @dukenv0307

@dukenv0307
Copy link
Contributor Author

Those changes work well. Please include them in the PR. @dukenv0307

@c3024 I updated and merged main.

@Julesssss
Copy link
Contributor

Seems like we're nearly there 👍

/**
* Check if the transaction has missing required fields
*/
function hasMissingRequiredFields(transaction: OnyxEntry<Transaction>): boolean {
Copy link
Contributor

@c3024 c3024 Feb 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is better to just use hasMissingSmartScanFields at the places where we added hasMissingRequiredFields even though the name hasMissingSmartScanFields might be a little misleading for other requests like manual requests with receipts.

Adding another function with a different name like this hasMissingRequiredFields that returns the same value as hasMissingSmartScanFields can be more confusing later IMO. @dukenv0307

cc: @Julesssss

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm on the fence. Having a better-described function name is good. But we can always do that later, or rename the existing function. @dukenv0307 is the idea that we'll eventually add to these functions to separate them?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding another function with a different name like this hasMissingRequiredFields that returns the same value as hasMissingSmartScanFields can be more confusing later

I agree with @c3024 comment. Just updated the PR to only use hasMissingSmartScanFields

@c3024
Copy link
Contributor

c3024 commented Feb 23, 2024

RBR on ReportPreview disappears when we remove the receipt.

I think we gotta modify ReportPreview as well here.

const hasErrors = (hasReceipts && hasMissingSmartscanFields) || (canUseViolations && ReportUtils.hasViolations(iouReportID, transactionViolations));

reportPreviewRedDot.mp4

@dukenv0307

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Feb 26, 2024

@c3024 I fixed your comment. The solution is to remove the hasReceipt in:

const hasErrors = (hasReceipts && hasMissingSmartscanFields) || (canUseViolations && ReportUtils.hasViolations(iouReportID, transactionViolations));

Video:

Screencast.from.26-02-2024.08.38.34.webm

@c3024
Copy link
Contributor

c3024 commented Feb 27, 2024

@dukenv0307 In the test steps, please add a step between 4 and 5 as something like

  1. Verify that the error and RBR stay at the 'Merchant' field

and after 'Add a receipt' step as same

Verify that the error and RBR stay at the 'Merchant' field

Copy link
Contributor

@c3024 c3024 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@melvin-bot melvin-bot bot requested a review from Julesssss February 27, 2024 11:53
@Julesssss Julesssss merged commit cfa0ae3 into Expensify:main Feb 27, 2024
16 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.45-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.45-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants